revXMLRPC_CreateRequest
Type
function
Summary
Creates an XML-RPC request structure, optionally setting its host, port, path and protocol.
Syntax
revXMLRPC_CreateRequest([<RPChost>],[<RPCport>],[<filePath>],[<connProtocol>])
Description
Use the revXMLRPC_CreateRequest function to create an XML-RPC document that you can use with other XML-RPC library commands and functions. XML-RPC is a remote procedure call (RPC) protocol which uses XML to encode its calls via a HTTP transport mechanism.
If the RPChost is empty, the revXMLRPC_CreateRequest function defaults the request host to be the computer running the application, also known as "localhost"
If the RPCport is empty, the revXMLRPC_CreateRequest function defaults the request port to 80, which is the default port for HTTP connections.
If the filePath is empty, the revXMLRPC_CreateRequest function defaults the request path to "RPC2", which is the standard path for XML-RPC server resources.
If the connProtocol is empty, the revXMLRPC_CreateRequest function defaults the request protocol to HTTP connections.
If the revXMLRPC_CreateRequest function encounters an error, it returns an error message starting with "xmlrpcerr". Such an error can also be captured and recalled using the revXMLRPC_Error function.
The revXMLRPC_CreateRequest function is part of the XML-RPC library. To ensure that the function works in a standalone application, you must include this custom library when you create your standalone. In the Inclusions pane of the Standalone Application Settings window, make sure the "XML-RPC" library checkbox is checked.
Parameters
| Name | Type | Description |
|---|---|---|
RPChost | string | The IP address or domain name of the host you want to connect to. |
RPCport | string | The port number you want to connect to. If you don't specify a port, port 80 is used. (On most systems, port 80 is used for HTTP connections.) |
filePath | string | Usually a file path, which allows the host to determine which resource handles your request. |
connProtocol | string | The protocol determines the type of connection that is established with the host. By default, XML-RPC uses HTTP connections, but for added security you can use HTTPS connections, if the host supports it. |
Examples
get revXMLRPC_CreateRequest(field "Host",field "Port",field "Path",field "Protocol")
put revXMLRPC_CreateRequest("example.com",80,"RPC2","http") into theRequest
Related
glossary: LiveCode custom library, return, XML-RPC, Standalone Application Settings, XML-RPC document, standalone application, function, command, HTTP
library: XML-RPC library
command: revXMLRPC_SetProtocol, revXMLRPC_SetPath, revXMLRPC_SetPort, revXMLRPC_SetSocket, revXMLRPC_DeleteAllDocuments
function: revXMLRPC_GetHost
Compatibility and Support
Introduced
LiveCode 2.5
OS
mac
windows
linux
ios
android
Platforms
desktop
server
mobile